[DOCS-1166][DOCS-880][DOCS-1167][DOCS-1168] Automation updates part 1 of 2 #1084

mdlinville · 2025-02-05T23:44:31Z

DOCS-1166 Update all possible links and references to old Model Registry
[DOCS-880]DOCS-1167 Consolidate project-scoped and model registry automations, new Slack notification flow, add redirects

A followup PR will add details about the new API when it is ready.
A followup PR will add details about run metrics automations
This PR assumes that the new Slack notifications will be available for all event types

Added @tonyyli-wandb @ibindlish for round 1 of technical review

Preview links for major changes:

…istry

… registry automations, new Slack notification flow, add redirects

content/guides/models/automations/_index.md

cloudflare-workers-and-pages · 2025-02-05T23:47:10Z

Deploying docs with Cloudflare Pages

Latest commit:	`98a2a20`
Status:	✅ Deploy successful!
Preview URL:	https://b8dcfb42.docodile.pages.dev
Branch Preview URL:	https://automation-updates.docodile.pages.dev

View logs

ssisk

added some comments!

When we do add the docs for run metric events, they need a lot more explanation of how they work than what we have here - we should definitely meet at that time to walk through it

content/guides/hosting/iam/_index.md

content/guides/models/automations/_index.md

ssisk · 2025-02-07T19:48:33Z

content/guides/models/automations/_index.md

+1. Provide a name for the webhook. 
+1. Provide the endpoint URL for the webhook.
+1. If the webhook authenticates using an access token, set **Access token** to the name of the secret that contains the access token. When you configure an automation that uses this webhook, the access token will be available in the `$ACCESS_TOKEN` environment variable, and the HTTP header will have `Authorization: Bearer $ACCESS_TOKEN`.
+1. If the webhook validates its payload using a sensitive string, set **Secret** to the name of the secret that contains the sensitive string.


So this doesn't really tell the user what happens to this value when we send the webhook. Is it sent in the body of the payload? is it available in the payload as $my_secret_name? is it sent in a header named secret?

So, TODO item for me: figure out what this does (unless @tonyyli-wandb knows off the top of your head?)

Let me know what you find out!

I believe I've addressed this now.

content/guides/models/automations/_index.md

ssisk · 2025-02-07T19:52:51Z

content/guides/models/automations/_index.md

+The following tabs demonstrate example payloads based on common use cases. Within the examples they reference the following keys to refer to condition objects in the payload parameters:
+* `${event_type}` Refers to the type of event that triggered the action.
+* `${event_author}` Refers to the user that triggered the action.
+* `${artifact_version}` Refers to the specific artifact version that triggered the action. Passed as an artifact instance.


We need to answer the question: what does it mean that something is 'passed as an artifact instance'?

Good idea. This content is copied from where it lives in the current doc, not net new in this PR.

content/guides/models/automations/_index.md

tonyyli-wandb

Partway through but have to step away, so wanted to leave any comments I have so far --

content/guides/integrations/huggingface.md

content/guides/integrations/yolov5.md

tonyyli-wandb · 2025-02-11T22:15:27Z

content/guides/models/automations/_index.md

+### Registry
+For a [registered model]({{< relref "/guides/models/registry/">}}), you can configure an automation to run on these events:
+
+- **Linking a new artifact to a registered model**: Test and validate new model candidates.


suggestion: Since we're trying to move away from language that restricts artifacts to models alone:

Suggested change

- **Linking a new artifact to a registered model**: Test and validate new model candidates.

- **Linking a new artifact to a collection**: Test and validate new models, datasets, etc.

note: Also, this event is supported at the project scope

tonyyli-wandb · 2025-02-11T22:16:35Z

content/guides/models/automations/_index.md

+For a [registered model]({{< relref "/guides/models/registry/">}}), you can configure an automation to run on these events:
+
+- **Linking a new artifact to a registered model**: Test and validate new model candidates.
+- **Adding a new alias to a version of the registered model**: Trigger a special step of your workflow when a new model version has a label or alias applied. For example, deploy a model when it has the `deploy` alias applied.


note: This event is supported at both the "project" and "artifact collection" scope

tonyyli-wandb · 2025-02-11T22:17:48Z

content/guides/models/automations/_index.md

+- **A new version of an artifact is created in a collection**: Apply recurring actions to each version of an artifact. For example, start a training job when a new dataset artifact version is created.
+- **An artifact alias is added**: Apply recurring actions when a specific alias is applied to an artifact version. For example, run a series of downstream processing steps when an artifact gains the `test-set-quality-check` alias.


note: These events can be scoped at either the project or artifact collection level as well

content/guides/models/automations/_index.md

content/guides/hosting/iam/_index.md

content/guides/models/automations/_index.md

Co-authored-by: Stephen Sisk <[email protected]>

github-actions · 2025-02-11T22:28:28Z

content/guides/models/automations/_index.md

+Specify the secrets you want to use for your webhook automation when you configure the webhook. See the [Configure a webhook]({{< relref "#configure-a-webhook" >}}) section for more information. 
+
+{{% alert %}}
+Once you create a secret and grant the webhook access to it, you can use it in your automation's webhook payload by prefixing its name with with `$`.


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Repetition] 'with' is repeated!

content/guides/models/automations/_index.md

- Move Secrets to new page - Remove mention of run scope - Some of the feedback so far

…ion_updates

mdlinville · 2025-02-14T23:14:55Z

Reviewers: I have resolved the comments that I think I have addressed so far. Run metric automations will now be handled in a followup PR. Comments that remain open will be addressed soon!

…ion_updates

Co-authored-by: Tony Li <[email protected]>

…ion_updates

mdlinville · 2025-02-19T00:56:51Z

I've implemented most of the open feedback from @ssisk @tonyyli-wandb , please take another look. Where I haven't said in the PR that it's addressed, I have not yet gotten to it (probably because I need to research it some more) or it will be addressed elsewhere.

mdlinville added 2 commits February 5, 2025 15:39

[DOCS-1166] Update all possible links and references to old Model Reg…

2e08a16

…istry

[DOCS-880][DOCS-1167][DOCS-1168] Consolidate project-scoped and model…

582d4db

… registry automations, new Slack notification flow, add redirects

mdlinville requested review from ibindlish and tonyyli-wandb February 5, 2025 23:44

mdlinville requested a review from a team as a code owner February 5, 2025 23:44

github-actions bot reviewed Feb 5, 2025

View reviewed changes

content/guides/models/automations/_index.md Outdated Show resolved Hide resolved

content/guides/models/automations/_index.md Outdated Show resolved Hide resolved

Style

643b6c3

mdlinville added 4 commits February 5, 2025 15:51

Markdown mistake

064288d

Fix links

f4bfe72

Fix another broken link

0f55a71

Merge remote-tracking branch 'origin/main' into automation_updates

a37335e

mdlinville mentioned this pull request Feb 6, 2025

Archive of proposed changes to automation topics #832

Closed

mdlinville requested a review from ssisk February 6, 2025 19:05

mdlinville added 2 commits February 6, 2025 11:05

Merge branch 'main' into automation_updates

22d0ccc

Merge branch 'main' into automation_updates

db6d7fa

ssisk reviewed Feb 7, 2025

View reviewed changes

mdlinville added 2 commits February 11, 2025 10:02

Merge branch 'main' into automation_updates

5b201a4

Merge remote-tracking branch 'origin/main' into automation_updates

3633fa7

mdlinville commented Feb 11, 2025

View reviewed changes

content/guides/models/automations/_index.md Outdated Show resolved Hide resolved

tonyyli-wandb reviewed Feb 11, 2025

View reviewed changes

mdlinville commented Feb 11, 2025

View reviewed changes

content/guides/hosting/iam/_index.md Outdated Show resolved Hide resolved

mdlinville commented Feb 11, 2025

View reviewed changes

content/guides/models/automations/_index.md Outdated Show resolved Hide resolved

Stephen's round 1 feedback

7a801c0

Co-authored-by: Stephen Sisk <[email protected]>

github-actions bot reviewed Feb 11, 2025

View reviewed changes

mdlinville commented Feb 11, 2025

View reviewed changes

content/guides/models/automations/_index.md Outdated Show resolved Hide resolved

mdlinville added 4 commits February 11, 2025 14:36

Apply suggestions from code review

c526e25

Merge remote-tracking branch 'origin/main' into automation_updates

2e74a54

Remove mention of run metrics automations

387b8dd

Feedback

ca18948

- Move Secrets to new page - Remove mention of run scope - Some of the feedback so far

Merge remote-tracking branch 'origin/automation_updates' into automat…

173901d

…ion_updates

mdlinville and others added 8 commits February 18, 2025 13:43

Merge branch 'main' into automation_updates

a6a5958

Merge remote-tracking branch 'origin/main' into automation_updates

1e45d26

Adjust link to secrets page

fdbac71

Merge remote-tracking branch 'origin/automation_updates' into automat…

8e12500

…ion_updates

Fill out remaining sections in the Secrets page

1a02164

Apply suggestions from code review

eef5f44

Co-authored-by: Tony Li <[email protected]>

Feedback

8cb89f6

Merge remote-tracking branch 'origin/automation_updates' into automat…

98a2a20

…ion_updates

mdlinville requested review from ssisk and tonyyli-wandb February 19, 2025 00:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DOCS-1166][DOCS-880][DOCS-1167][DOCS-1168] Automation updates part 1 of 2 #1084

[DOCS-1166][DOCS-880][DOCS-1167][DOCS-1168] Automation updates part 1 of 2 #1084

mdlinville commented Feb 5, 2025 •

edited

Loading

cloudflare-workers-and-pages bot commented Feb 5, 2025 •

edited

Loading

ssisk left a comment

ssisk Feb 7, 2025

mdlinville Feb 11, 2025

mdlinville Feb 19, 2025

ssisk Feb 7, 2025

mdlinville Feb 11, 2025

tonyyli-wandb left a comment

tonyyli-wandb Feb 11, 2025

tonyyli-wandb Feb 11, 2025

mdlinville Feb 14, 2025

tonyyli-wandb Feb 11, 2025

mdlinville Feb 14, 2025

tonyyli-wandb Feb 11, 2025

mdlinville Feb 19, 2025

github-actions bot Feb 11, 2025

mdlinville commented Feb 14, 2025

mdlinville commented Feb 19, 2025

	- Linking a new artifact to a registered model: Test and validate new model candidates.
	- Linking a new artifact to a collection: Test and validate new models, datasets, etc.

		- A new version of an artifact is created in a collection: Apply recurring actions to each version of an artifact. For example, start a training job when a new dataset artifact version is created.
		- An artifact alias is added: Apply recurring actions when a specific alias is applied to an artifact version. For example, run a series of downstream processing steps when an artifact gains the `test-set-quality-check` alias.

[DOCS-1166][DOCS-880][DOCS-1167][DOCS-1168] Automation updates part 1 of 2 #1084

Are you sure you want to change the base?

[DOCS-1166][DOCS-880][DOCS-1167][DOCS-1168] Automation updates part 1 of 2 #1084

Conversation

mdlinville commented Feb 5, 2025 • edited Loading

cloudflare-workers-and-pages bot commented Feb 5, 2025 • edited Loading

Deploying docs with Cloudflare Pages

ssisk left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tonyyli-wandb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot Feb 11, 2025

Choose a reason for hiding this comment

mdlinville commented Feb 14, 2025

mdlinville commented Feb 19, 2025

mdlinville commented Feb 5, 2025 •

edited

Loading

cloudflare-workers-and-pages bot commented Feb 5, 2025 •

edited

Loading